/*
 * LensKit, an open-source toolkit for recommender systems.
 * Copyright 2014-2017 LensKit contributors (see CONTRIBUTORS.md)
 * Copyright 2010-2014 Regents of the University of Minnesota
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.lenskit.util.table;

import java.util.List;

/**
 * This is the interface for the in memory table which stores a list of rows. Users should be able
 * to call the filter method to find the rows that satisfy the conditions specified by users. And
 * table expose the functions of columns to enable users calling the functions on column.
 *
 * @author <a href="http://www.grouplens.org">GroupLens Research</a>
 */
public interface Table extends List<Row> {
    Table filter(String header, Object data);

    /**
     * Get a column by index.
     * @param idx The column index (starting from 0).
     * @return The column.
     * @throws IllegalArgumentException if <var>idx</var> is out of bounds.
     */
    Column column(int idx);

    /**
     * Get a column by name.
     * @param col The column name.
     * @return The column.
     * @throws IllegalArgumentException if <var>col</var> is not a valid column.
     */
    Column column(String col);

    /**
     * Get the layout of this table.
     * @return The table layout.
     */
    TableLayout getLayout();
}
